This file contains API for Vacuum 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
#include "drv_i2c_master.h"

Data Structures
struct	vacuum2_t
	Vacuum 2 Click context object. More...
struct	vacuum2_cfg_t
	Vacuum 2 Click configuration object. More...

Macros
#define	VACUUM2_PRESSURE_PA_MIN -2000
	Vacuum 2 pressure calculation setting.
#define	VACUUM2_PRESSURE_PA_MAX 2000
#define	VACUUM2_PRESSURE_SENS_PA 0.001
#define	VACUUM2_ADC_VOUT_MULTIPLIER 2
#define	VACUUM2_NUM_CONVERSIONS 200
	Vacuum 2 default ADC samples number for averaging.
#define	VACUUM2_ADC_RESOLUTION 0x0FFF
	Vacuum 2 ADC setting.
#define	VACUUM2_VREF_3V3 3.3
#define	VACUUM2_VREF_5V 5.0
#define	VACUUM2_TIMEOUT_MS 2000
	Vacuum 2 timeout setting.
#define	VACUUM2_SET_DEV_ADDR 0x4D
	Vacuum 2 device address setting.
#define	VACUUM2_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	vacuum2_drv_t { VACUUM2_DRV_SEL_ADC , VACUUM2_DRV_SEL_I2C }
	Vacuum 2 Click driver selector. More...
enum	vacuum2_return_value_t { VACUUM2_OK = 0 , VACUUM2_ERROR = -1 }
	Vacuum 2 Click return value data. More...

Functions
void	vacuum2_cfg_setup (vacuum2_cfg_t *cfg)
	Vacuum 2 configuration object setup function.
void	vacuum2_drv_interface_sel (vacuum2_cfg_t *cfg, vacuum2_drv_t drv_sel)
	Vacuum 2 driver interface setup function.
err_t	vacuum2_init (vacuum2_t ctx, vacuum2_cfg_t cfg)
	Vacuum 2 initialization function.
err_t	vacuum2_read_adc_raw (vacuum2_t ctx, uint16_t raw_adc)
	Vacuum 2 read raw ADC value function.
err_t	vacuum2_read_adc_voltage (vacuum2_t ctx, float voltage)
	Vacuum 2 read voltage level function.
err_t	vacuum2_set_vref (vacuum2_t *ctx, float vref)
	Vacuum 2 set vref function.
err_t	vacuum2_read_vout (vacuum2_t ctx, float vout)
	Vacuum 2 read vout function.
err_t	vacuum2_read_vout_avg (vacuum2_t ctx, uint16_t num_conv, float vout_avg)
	Vacuum 2 read vout avg function.
err_t	vacuum2_calib_offset (vacuum2_t *ctx)
	Vacuum 2 calib offset function.
err_t	vacuum2_read_pressure (vacuum2_t ctx, int16_t pressure)
	Vacuum 2 read pressure function.

Detailed Description

This file contains API for Vacuum 2 Click Driver.

Enumeration Type Documentation

Vacuum 2 Click driver selector.

Selects target driver interface of Vacuum 2 Click driver.

Enumerator
VACUUM2_DRV_SEL_ADC	ADC driver descriptor.
VACUUM2_DRV_SEL_I2C	I2C driver descriptor.

Vacuum 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
VACUUM2_OK
VACUUM2_ERROR